Thank you for your interest in contributing to the NEAR ecosystem! We welcome contributions from everyone, and we appreciate your help in driving the development activity in our community.
To contribute to NEAR, please follow these steps:
- Fork the repository to your own GitHub account.
- Create a new branch for your contribution.
- Make your changes and improvements.
- Test your changes to ensure they work as expected.
- Commit your changes and push them to your forked repository.
- Open a pull request (PR) from your forked repository to the main NEAR repository.
- Feel free to submit draft PRs to get early feedback and to make sure you are on the right track.
- The PR name should follow the template:
<type>: <name>
. Wheretype
is:fix
for bug fixes;feat
for new features;refactor
for changes that reorganize code without adding new content;doc
for changes that change documentation or comments;test
for changes that introduce new tests;chore
for grunt tasks like updating dependencies.
- Provide a clear and descriptive title for your PR.
- Include a detailed description of the changes you made and why they are valuable.
- Wait for the maintainers to review your PR and provide feedback.
- Make any necessary updates based on the feedback received.
- Once your PR is approved, it will be merged into the main repository.
If you encounter any issues or have suggestions for improvements, please open an issue in the repository's issue tracker (Note: If there are no open issues, you'll see a message indicating this.) Provide as much detail as possible, including steps to reproduce the issue and any relevant code snippets.
We expect all contributors to adhere to our community guidelines, which can be found in the repository's CODE_OF_CONDUCT.md file. Please be respectful and inclusive in all interactions within the NEAR community.
If you have any questions or need further assistance, feel free to reach out to us on our official communication channels, such as our Discord or Telegram channels.
We appreciate your contributions and look forward to working with you to build an amazing web3 ecosystem with NEAR!