Skip to content

Commit 23b3e23

Browse files
authored
Merge pull request #67 from salesforce/add-CONTRIBUTING
added CONTRIBUTING.md file
2 parents 0b284df + 6f460d0 commit 23b3e23

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing
2+
3+
Welcome to Grammaticus! We appreciate your interest in contributing to our open source projects on GitHub.
4+
5+
## Issues
6+
7+
We encourage you to submit issues and enhancement requests through our [GitHub Issues](https://github.com/salesforce/grammaticus/issues) page. Please check existing issues before creating new ones to avoid duplicates.
8+
9+
## Contributing Process
10+
11+
We follow the "fork-and-pull" Git workflow for contributions:
12+
13+
1. Fork the repository on GitHub
14+
2. Clone the project to your local machine
15+
3. Create a feature branch and commit your changes
16+
4. Push your work to your fork on GitHub
17+
5. Submit a Pull Request for review
18+
19+
**Important**: Always merge the latest changes from "upstream" before making a pull request to ensure your code is up-to-date.
20+
21+
## Coding Standards
22+
23+
Code consistency is paramount. Please adhere to the following guidelines:
24+
- Follow the existing style, formatting, and naming conventions of the file you're modifying
25+
- Write clear, descriptive commit messages
26+
- Include appropriate documentation for new features
27+
- Add tests for new functionality
28+
29+
## License
30+
31+
This project is licensed under the [Grammaticus License](https://github.com/salesforce/grammaticus/blob/master/LICENSE.txt). By contributing, you agree to license your contributions under the same terms.

0 commit comments

Comments
 (0)