-
Notifications
You must be signed in to change notification settings - Fork 203
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
1 changed file
with
82 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
# Contributing to MixPost | ||
|
||
👍🎉 First off, thanks for taking the time to contribute! 🎉👍 | ||
|
||
The following is a set of guidelines for contributing to MixPost, which is hosted at https://github.com/inovector/mixpost. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. | ||
|
||
## Code of Conduct | ||
|
||
This project and everyone participating in it is governed by the MixPost Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]]. | ||
|
||
## What Should I Know Before I Get Started? | ||
|
||
### Project Setup | ||
|
||
If there are any steps specific to setting up the project environment or prerequisites such as installing Node.js, PHP, WordPress, or other dependencies, detail those steps here to help new contributors get started. | ||
|
||
### Project Structure | ||
|
||
Explain the basic structure of the project to help newcomers understand where to find certain types of files or where to place new files. | ||
|
||
## How Can I Contribute? | ||
|
||
### Reporting Bugs | ||
|
||
This section guides contributors through the process of reporting a bug. | ||
|
||
#### Before Submitting a Bug Report | ||
|
||
- Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/inovector/mixpost/issues). | ||
- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/inovector/mixpost/issues/new). Be sure to include a title, clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring. | ||
|
||
### Suggesting Enhancements | ||
|
||
This section guides contributors through the process of suggesting enhancements. | ||
|
||
- Include steps to reproduce the problem you're trying to solve or the motivation for the change you're proposing. | ||
- Provide clear descriptions of the enhancement with as much detail and context as possible. | ||
|
||
### Your First Code Contribution | ||
|
||
- If you're looking for a way to start contributing, check out the "good first issue" label in the Issues section. | ||
|
||
### Pull Requests | ||
|
||
- Fill in the required template for the pull request. | ||
- Follow the coding conventions and quality standards specific to this project. | ||
- Include appropriate test cases for your change. | ||
- Document new code based on the project's documentation standards. | ||
|
||
## Styleguides | ||
|
||
### Git Commit Messages | ||
|
||
- Use the present tense ("Add feature" not "Added feature"). | ||
- Use the imperative mood ("Move cursor to..." not "Moves cursor to..."). | ||
- Limit the first line to 72 characters or less. | ||
- Reference issues and pull requests liberally after the first line. | ||
|
||
### JavaScript Styleguide | ||
|
||
- All JavaScript must adhere to [JavaScript Standard Style](https://standardjs.com). | ||
|
||
### PHP Styleguide | ||
|
||
- Follow [PSR-12](https://www.php-fig.org/psr/psr-12/) as much as possible. | ||
|
||
### CSS Styleguide | ||
|
||
- Use BEM naming conventions for classes. | ||
- Use variables for color, font-size, etc., to maintain consistency. | ||
|
||
## Additional Notes | ||
|
||
### Issue and Pull Request Labels | ||
|
||
This section can be used to explain the labels used for issues and pull requests. | ||
|
||
## Questions? | ||
|
||
Feel free to contact the project maintainers by [insert contact method]. We welcome feedback and are here to assist the community. | ||
|
||
Thank you for contributing to MixPost! |