- Notifications
You must be signed in to change notification settings - Fork0
zayne-labs/contribute
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
- Getting Started
- Finding an Issue
- Creating a Pull Request
- Coding Standards
- Testing
- Documentation
- Review Process
- Community Guidelines
- License
Before you begin contributing, make sure you have the following set up on your local machine:
- Git installed
- A GitHub account
- Visit our project's GitHub repository.
- Go to the "Issues" tab.
- Browse through the list of open issues.
- Filter issues based on your skills, interests, or availability.
- Comment on the issue you'd like to work on to express your interest or ask questions.
- To auto-assign an issue to yourself, reply with
.take
in the issue comment.
- Fork the repository to your GitHub account.
- Clone your forked repository to your local machine.
- Create a new branch for your contribution.
- Make your changes and commit them with clear and concise commit messages.
- Push your changes to your forked repository.
- Create a pull request (PR) against the
dev
branch.
- Follow the coding style and standards used in the project.
- Ensure your code is well-documented.
- Use meaningful variable and function names.
- Maintain consistency with existing code.
- Test your code thoroughly to ensure it works as intended.
- Write tests where applicable.
- Ensure that all existing tests pass.
- Include test cases that cover both normal and edge cases.
- Update or create documentation as necessary for your changes.
- Keep documentation clear and concise.
- If you make significant changes, update the project's README or documentation files.
To update or create documentation, you need to have Markdown knowledge.Visithere to read about GitHub Markdown andhere to practice.
- Your PR will be reviewed by maintainers and contributors.
- Be responsive to feedback and make necessary changes.
- The PR may be merged once it receives approvals and passes automated tests.
- Be respectful and considerate of other contributors.
- Follow the project's code of conduct.
- Encourage a positive and inclusive community environment.
- Help others and answer questions when possible.
By contributing to this project, you agree that your contributions will be licensed under the project's open-source license. Make sure to review and understand the project's license before contributing.