|
1 | | -Hey there! We are really excited that you are interested in contributing. Before submitting your contribution, please make sure to take a moment and read through the following guide: |
2 | | -## Sending Pull Request |
| 1 | +# Contributing |
3 | 2 |
|
4 | | -### Discuss First |
| 3 | +Thank you for your interest in massCode. The project accepts external pull requests only for localizations and new syntax highlighting languages. Development is maintained by the project author. |
5 | 4 |
|
6 | | -Before you start to work on a feature pull request, it's always better to open a feature request issue first to [discuss](https://github.com/massCodeIO/massCode/discussions) with the maintainers whether the feature is desired and the design of those features. This would help save time for both the maintainers and the contributors and help features to be shipped faster. |
| 5 | +You can help by reporting bugs and sharing ideas through the channels below. |
7 | 6 |
|
8 | | -For typo fixes, it's recommended to batch multiple typo fixes into one pull request to maintain a cleaner commit history. |
| 7 | +## Bug Reports |
9 | 8 |
|
10 | | -### Commit Convention |
| 9 | +Please [open an issue](https://github.com/massCodeIO/massCode/issues/new/choose) for bugs. Search existing issues first to avoid duplicates, and include steps to reproduce the problem, your massCode version, and system information. |
11 | 10 |
|
12 | | -We use [Conventional Commits](https://www.conventionalcommits.org/) for commit messages, which allows the changelog to be auto-generated based on the commits. Please read the guide through if you aren't familiar with it already. |
| 11 | +## Feature Requests and Ideas |
13 | 12 |
|
14 | | -Only `fix:` and `feat:` will be presented in the changelog. |
| 13 | +Please use [GitHub Discussions](https://github.com/massCodeIO/massCode/discussions) for feature requests, ideas, and questions. Search existing discussions before starting a new one. |
15 | 14 |
|
16 | | -Note that `fix:` and `feat:` are for actual code changes (that might affect logic). For typo or document changes, use docs: or chore: instead: |
| 15 | +## Pull Requests |
17 | 16 |
|
18 | | -- ~~`fix: typo`~~ -> `docs: fix typo` |
| 17 | +External pull requests are welcome for: |
19 | 18 |
|
20 | | -### Pull Request |
| 19 | +- Adding or improving localizations. |
| 20 | +- Adding support for new syntax highlighting languages. |
21 | 21 |
|
22 | | -If you don't know how to send a Pull Request, we recommend reading the [guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). |
| 22 | +Please keep your pull request focused on one of these areas. Use [Conventional Commits](https://www.conventionalcommits.org/) for commit messages and the pull request title. |
23 | 23 |
|
24 | | -When sending a pull request, make sure your PR's title also follows the Commit Convention. |
| 24 | +All other external pull requests will be closed. Please report bugs in Issues or share feature requests and ideas in Discussions instead. |
25 | 25 |
|
26 | | -If your PR fixes or resolves an existing issue, please add the following line in your PR description (replace 123 with a real issue number): |
27 | | - |
28 | | -``` |
29 | | -fix #123 |
30 | | -``` |
31 | | - |
32 | | -It's ok to have multiple commits in a single PR, you don't need to rebase or force push for your changes as we will use Squash and Merge to squash the commits into one commit when merging. |
33 | | - |
34 | | -And of course please test your code before PR. |
| 26 | +Please follow our [Code of Conduct](CODE_OF_CONDUCT.md) when participating in issues, discussions, and pull requests. |
0 commit comments